Selecting patron self-edit fields in Web Services for Symphony
This topic describes the attributes in Web Services associated with patron contact information. Each field can be set to one of the following values:
- Disabled – Patron users cannot see or modify the field.
- Read-only – Patron users can see the field's value, but cannot modify it.
- Editable – Patron users can see and modify the field's value.
You may want to make some of these fields editable by the patron and keep the patron from editing other fields. For example, you may want to allow patrons to change their birthdayte (birthDate), but you probably do not want them to have control over their standings (standing). The patron information associated with each field is listed below to help you make those decisions.
Enterprise recognizes which fields are enabled and disabled for editing in the Web Services Admin console and only allows patrons to enter information into editable fields.
Most of the fields are automatically displayed in the patron interface with user-friendly labels. However, for certain fields, you must set user-friendly labels the same way you would make any other custom label change. For more information on this, contact SirsiDynix Customer Support.
| |
Because of an issue in Web Services 2016.08.1, when the code and data fields are set to hidden within Web Services but any of the Policy Key values are set to something other than Hidden, an error occurs that causes never-ending loading spinners within the patron information tab in My Account. This problem will be fixed in a later release of Web Services. |
| |
Setting the patron self-edit options may require coordination with your Web Services administrator. To learn how to set each of these fields as editable, see the "Resource Security Configuration" help topic in the Symphony Web Services Admin Guide. |
/user/patron
The following table contains fields that are associated with general patron information:
| Field | Description |
|---|---|
|
address1 |
Specifies an address that can be used for the patron user. |
|
address2 |
Specifies an address that can be used for the patron user. |
|
address3 |
Specifies an address that can be used for the patron user. |
|
alternateID |
Specifies the alternate ID of the patron user. |
|
barcode |
Specifies the barcode associated with the patron user. |
|
birthDate |
Specifies the date of birth of the patron user. |
|
category1 |
Specifies a patron user statistic value. |
|
category2 |
Specifies a patron user statistic value. |
|
category3 |
Specifies a patron user statistic value. |
|
category4 |
Specifies a patron user statistic value. |
|
category5 |
Specifies a patron user statistic value. |
|
category6 |
Specifies a patron user statistic value. |
|
category7 |
Specifies a patron user statistic value. |
|
category8 |
Specifies a patron user statistic value. |
|
category9 |
Specifies a patron user statistic value. |
|
category10 |
Specifies a patron user statistic value. |
|
category11 |
Specifies a patron user statistic value. |
|
category12 |
Specifies a patron user statistic value. |
|
claimsReturnedCount |
Specifies the number of claims returned associated with the patron. |
|
department |
Specifies the value set for the Department field in this patron user's record. |
|
displayName |
Specifies how the patron user wants his or her name to display in library communications. |
|
firstName |
Specifies the first name of the patron user. |
|
language |
Specifies the language the patron user wants to use for library communications. |
|
lastActivityDate |
Specifies the last date the patron user used his or her library account. |
|
lastName |
Specifies the last name of the patron user. |
|
library |
Specifies the library to which the patron user belongs. |
|
middleName |
Specifies the middle name of the patron user. |
|
preferredName |
Specifies the name which the patron user prefers to have listed in library communication. |
|
privilegeExpiresDate |
Specifies the date on which the patron user's circulation privileges expire. |
|
standing |
Specifies the patron user's standing. |
|
suffix |
Specifies the suffix of the patron user's name, if applicable. |
|
title |
Specifies the title of the patron user, if applicable. |
|
usePreferredName |
Specifies whether or not the library system should use the patron user's preferred name in library communications. |
/user/patron/address1
The following table contains fields that are associated with patron contact information:
| Field | Description |
|---|---|
|
code |
Specifies the type of field the address contains. For example, STREET, PHONE, or ZIP). |
|
data |
Specifies the value that corresponds to the specified code. |
user/patron/address2
The following table contains fields that are associated with patron contact information:
| Field | Description |
|---|---|
|
code |
Specifies the type of field the address contains. For example, STREET, PHONE, or ZIP). |
|
data |
Specifies the value that corresponds to the specified code. |
user/patron/address3
The following table contains fields that are associated with patron contact information:
| Field | Description |
|---|---|
|
code |
Specifies the type of field the address contains. For example, STREET, PHONE, or ZIP). |
|
data |
Specifies the value that corresponds to the specified code. |